<?php
/**
 * Ruth Library
 * $Id: FieldGroup.php 7 2008-02-19 16:03:43Z baron314159@yahoo.com $
 *
 * LICENSE
 *
 * Copyright (c) 2007, Chris Utz
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Impact Lab nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY CHRIS UTZ ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL CHRIS UTZ BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @category   Ruth
 * @package    Ruth_Channel
 * @author     Chris Utz <chris@chrisutz.com>
 * @copyright  2007 Chris Utz <chris@chrisutz.com>
 * @license    http://www.opensource.org/licenses/bsd-license.php    New BSD License
 * @version    $Revision: 7 $
 */

/**
 * @see Ruth_Channel_Exception
 */
require_once 'Ruth/Channel/Exception.php';

/**
 * Wrapper around an array of Ruth_Channel_Field objects; allows methods
 * of Ruth_Channel_Field to be called on an entire collection of fields.
 *
 * @category   Ruth
 * @package    Ruth_Channel
 * @author     Chris Utz <chris@chrisutz.com>
 * @copyright  2007 Chris Utz <chris@chrisutz.com>
 * @license    http://www.opensource.org/licenses/bsd-license.php    New BSD License
 * @version    $Revision: 7 $
 */
class Ruth_Channel_FieldGroup
{
    /**
     * An array of Ruth_Channel_Field objects.
     * 
     * @var array
     */
    protected $_fields = array();

    /**
     * Creates an instance of Ruth_Channel_FieldGroup
     *
     * @var array $fields An array of Ruth_Channel_Field objects.
     * @return void
     */
    public function __construct(array $fields)
    {
        $this->_fields = $fields;
    }

    /**
     * A proxy interface to Ruth_Channel_Field methods.
     * 
     * @var string $name
     * @var array $arguments
     * @return Ruth_Channel_FieldGroup
     */
    public function __call($name, array $arguments)
    {
        foreach ($this->_fields as $field) {
            $class = new ReflectionClass($field);

            if ($class->hasMethod($name)) {
                $method = new ReflectionMethod($field, $name);
                $method->invokeArgs($field, $arguments);
            } else {
                throw new Ruth_Channel_Exception("cannot proxy method, {$class->getName()} does not have method {$name}");
            }
        }

        return $this;
    }

    /**
     * Returns the fields in the field group as an array.
     *
     * @return array An array of Ruth_Channel_Field objects.
     */
    public function toArray()
    {
        return $this->_fields;
    }
}
 
// vim: sw=4:ts=4:sts=4:et
